add validation for name and description for model model group and connector resources #3805

dhrubo-os · 2025-04-29T19:29:42Z

add validation for name and description for model model group and connector resources

Description

resolved #3639

Integ test will fail as code coverages is failing for previously merged PR.

Related Issues

Resolves #[Issue number to be closed when this PR is merged]

Check List

New functionality includes testing.
New functionality has been documented.
API changes companion pull request created.
Commits are signed per the DCO using --signoff.
Public documentation issue/PR created.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

ylwu-amzn · 2025-04-29T19:36:52Z

common/src/main/java/org/opensearch/ml/common/transport/connector/MLCreateConnectorRequest.java

+
+        if (modelName != null && !isSafeText(modelName)) {
+            exception = addValidationError(
+                "Model connector name can only contain letters, digits, spaces, underscores (_), hyphens (-), and dots (.)",


This error message is different with MLUpdateConnectorRequest.java one. Should we keep them consistent ?

"Model connector name can only contain letters, digits, spaces, underscores (_), hyphens (-), and dots (.). Max length: 1000 characters.",

Yes, in the next revision I kept it consistent.

ylwu-amzn · 2025-04-29T19:37:48Z

common/src/main/java/org/opensearch/ml/common/transport/connector/MLUpdateConnectorRequest.java

+
+            if (modelName != null && !isSafeText(modelName)) {
+                exception = addValidationError(
+                    "Model connector name can only contain letters, digits, spaces, underscores (_), hyphens (-), and dots (.). Max length: 1000 characters.",


Don't see where validate Max length: 1000 characters." , Is that built-in logic in isSafeText?

My bad, I removed that restriction from the regex. But then I forgot to remove that from the error message.

Initially I was thinking to provide 1000 characters restriction.

What do you think? Should we add such kind of restriction?

Ignore the comment, find that internal logic in isSafeText

ylwu-amzn · 2025-04-29T19:39:23Z

common/src/main/java/org/opensearch/ml/common/transport/model/MLUpdateModelRequest.java

+        String modelName = updateModelInput.getName();
+        String description = updateModelInput.getDescription();
+
+        if (modelName != null && !isSafeText(modelName)) {


Similar checking in multiple places ? Can we build some common util method ?

Yeah, I thought about that and felt too lazy to refactor 😄. But I fixed it in the second revision. Thanks for insisting on the highest standards!

Signed-off-by: Dhrubo Saha <[email protected]>

…eld too Signed-off-by: Dhrubo Saha <[email protected]>

chloewqg · 2025-05-15T19:07:28Z

Hello! Do we also consider adding / in model name. Currently I am not able to create and register a local model:

POST /_plugins/_ml/models/_register
{
  "name": "huggingface/sentence-transformers/msmarco-distilbert-base-tas-b",
  "version": "1.0.2",
  "model_group_id": "Z1eQf4oB5Vm0Tdw8EIP2",
  "model_format": "TORCH_SCRIPT"
}

{
	"error": {
		"root_cause": [
			{
				"type": "action_request_validation_exception",
				"reason": "Validation Failed: 1: Model name can only contain letters, numbers, whitespace, and basic punctuation (.,!?():@-_'\");"
			}
		],
		"type": "action_request_validation_exception",
		"reason": "Validation Failed: 1: Model name can only contain letters, numbers, whitespace, and basic punctuation (.,!?():@-_'\");"
	},
	"status": 400
}

…nector resources (opensearch-project#3805) * add validation for name and description for model model group and connector resources Signed-off-by: Dhrubo Saha <[email protected]> * addressing comment, added a common method in utils to remove code redundnancy Signed-off-by: Dhrubo Saha <[email protected]> * making more flexible the regex pattern Signed-off-by: Dhrubo Saha <[email protected]> * removing restriction of 1000 characters Signed-off-by: Dhrubo Saha <[email protected]> * addressing comments Signed-off-by: Dhrubo Saha <[email protected]> * fixing unit test messages Signed-off-by: Dhrubo Saha <[email protected]> * fixing unit test assertion Signed-off-by: Dhrubo Saha <[email protected]> * adding a generic way so that we can check for optional or required field too Signed-off-by: Dhrubo Saha <[email protected]> --------- Signed-off-by: Dhrubo Saha <[email protected]> Signed-off-by: Abdul Muneer Kolarkunnu <[email protected]>

dhrubo-os requested review from b4sjoo, mingshl, jngz-es, model-collapse, rbhavna, ylwu-amzn, zane-neo, Zhangxunmt, austintlee, HenryL27 and xinyual as code owners April 29, 2025 19:29

dhrubo-os had a problem deploying to ml-commons-cicd-env April 29, 2025 19:31 — with GitHub Actions Error

dhrubo-os had a problem deploying to ml-commons-cicd-env April 29, 2025 19:31 — with GitHub Actions Failure

dhrubo-os had a problem deploying to ml-commons-cicd-env April 29, 2025 19:31 — with GitHub Actions Error

dhrubo-os had a problem deploying to ml-commons-cicd-env April 29, 2025 19:31 — with GitHub Actions Failure

ylwu-amzn reviewed Apr 29, 2025

View reviewed changes

dhrubo-os had a problem deploying to ml-commons-cicd-env April 29, 2025 20:45 — with GitHub Actions Error

dhrubo-os had a problem deploying to ml-commons-cicd-env April 29, 2025 20:45 — with GitHub Actions Failure

dhrubo-os had a problem deploying to ml-commons-cicd-env April 29, 2025 20:45 — with GitHub Actions Error

dhrubo-os had a problem deploying to ml-commons-cicd-env April 29, 2025 20:45 — with GitHub Actions Failure

dhrubo-os force-pushed the input_validation branch from 0326043 to d8eeede Compare April 29, 2025 20:49

dhrubo-os had a problem deploying to ml-commons-cicd-env April 29, 2025 20:50 — with GitHub Actions Failure

dhrubo-os had a problem deploying to ml-commons-cicd-env April 29, 2025 20:50 — with GitHub Actions Error

dhrubo-os had a problem deploying to ml-commons-cicd-env April 29, 2025 20:50 — with GitHub Actions Failure

dhrubo-os had a problem deploying to ml-commons-cicd-env April 29, 2025 23:25 — with GitHub Actions Failure

dhrubo-os had a problem deploying to ml-commons-cicd-env April 29, 2025 23:25 — with GitHub Actions Error

dhrubo-os had a problem deploying to ml-commons-cicd-env April 29, 2025 23:25 — with GitHub Actions Failure

dhrubo-os added 4 commits May 14, 2025 10:30

removing restriction of 1000 characters

8310e23

Signed-off-by: Dhrubo Saha <[email protected]>

addressing comments

615230a

Signed-off-by: Dhrubo Saha <[email protected]>

fixing unit test messages

f52d7d5

Signed-off-by: Dhrubo Saha <[email protected]>

fixing unit test assertion

bd58f0f

Signed-off-by: Dhrubo Saha <[email protected]>

dhrubo-os temporarily deployed to ml-commons-cicd-env May 14, 2025 17:31 — with GitHub Actions Inactive

dhrubo-os had a problem deploying to ml-commons-cicd-env May 14, 2025 18:35 — with GitHub Actions Failure

dhrubo-os had a problem deploying to ml-commons-cicd-env May 14, 2025 18:35 — with GitHub Actions Error

adding a generic way so that we can check for optional or required fi…

b0610da

…eld too Signed-off-by: Dhrubo Saha <[email protected]>

dhrubo-os force-pushed the input_validation branch from 2ffd197 to b0610da Compare May 14, 2025 19:45

dhrubo-os temporarily deployed to ml-commons-cicd-env May 14, 2025 19:46 — with GitHub Actions Inactive

dhrubo-os had a problem deploying to ml-commons-cicd-env May 14, 2025 19:46 — with GitHub Actions Failure

dhrubo-os had a problem deploying to ml-commons-cicd-env May 14, 2025 19:46 — with GitHub Actions Error

jngz-es approved these changes May 14, 2025

View reviewed changes

dhrubo-os temporarily deployed to ml-commons-cicd-env May 14, 2025 20:31 — with GitHub Actions Inactive

dhrubo-os had a problem deploying to ml-commons-cicd-env May 14, 2025 21:34 — with GitHub Actions Error

dhrubo-os had a problem deploying to ml-commons-cicd-env May 14, 2025 21:34 — with GitHub Actions Failure

rbhavna approved these changes May 15, 2025

View reviewed changes

dhrubo-os merged commit f6a25f5 into opensearch-project:main May 15, 2025
12 of 14 checks passed

chloewqg mentioned this pull request May 15, 2025

Breaking Change in creating a local model #3853

Closed

dbwiddis mentioned this pull request May 29, 2025

[FEATURE] Use ML Commons validation methods in Workflow parsing opensearch-project/flow-framework#1152

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

add validation for name and description for model model group and connector resources #3805

add validation for name and description for model model group and connector resources #3805

dhrubo-os commented Apr 29, 2025 •

edited

Loading

Uh oh!

ylwu-amzn Apr 29, 2025 •

edited

Loading

Uh oh!

dhrubo-os Apr 29, 2025

Uh oh!

ylwu-amzn Apr 29, 2025

Uh oh!

dhrubo-os Apr 29, 2025

Uh oh!

ylwu-amzn Apr 29, 2025

Uh oh!

ylwu-amzn Apr 29, 2025

Uh oh!

dhrubo-os Apr 29, 2025

Uh oh!

Uh oh!

chloewqg commented May 15, 2025

Uh oh!

Uh oh!

add validation for name and description for model model group and connector resources #3805

add validation for name and description for model model group and connector resources #3805

Conversation

dhrubo-os commented Apr 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Check List

Uh oh!

ylwu-amzn Apr 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dhrubo-os Apr 29, 2025

Choose a reason for hiding this comment

Uh oh!

ylwu-amzn Apr 29, 2025

Choose a reason for hiding this comment

Uh oh!

dhrubo-os Apr 29, 2025

Choose a reason for hiding this comment

Uh oh!

ylwu-amzn Apr 29, 2025

Choose a reason for hiding this comment

Uh oh!

ylwu-amzn Apr 29, 2025

Choose a reason for hiding this comment

Uh oh!

dhrubo-os Apr 29, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

chloewqg commented May 15, 2025

Uh oh!

Uh oh!

dhrubo-os commented Apr 29, 2025 •

edited

Loading

ylwu-amzn Apr 29, 2025 •

edited

Loading